home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / lmatch15.zip / LMATCH.DOC < prev    next >
Text File  |  1992-12-25  |  23KB  |  520 lines
  1.  
  2.                               LETTER  MATCH
  3.  
  4.                                   v1.4
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20. LETTER MATCH is an easy to play and very challenging word game, designed
  21. to test your memory, category knowledge and spelling.
  22.  
  23. The object of the game is to match as many words as possible, each time
  24. trying to beat the score you have posted in the high score file, as well
  25. other players scores.
  26.  
  27. The Sysop determines the category subject and the program will display it
  28. at the top of the box that contains the current word you are working with.
  29.  
  30. You must think of a word, in line with the current category, whose first
  31. letter matches the last letter of the word in the box OR whose last letter
  32. matches the first letter of the word in the box.
  33.  
  34. For Example: Given the category "STATES and CAPITALS" and an initial word
  35.              of "OREGON", you could use "OHIO" to match the first letter
  36.              in "OREGON" or you could use "NEW YORK" to match the last
  37.              letter in "OREGON".
  38.  
  39.  
  40.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  41.          created in the directory you run the door from.
  42.  
  43.  
  44.  
  45.                               INSTALLATION
  46.                               ____________
  47.  
  48.  
  49.    Installation is fairly easy and straight-forward. The following steps and
  50.    examples should have you up and running in a very short period of time.
  51.    It is assumed that you are familiar with setting up DOORS on your system.
  52.    To this end, only examples of the configuration file and Door batch file
  53.    are described.
  54.  
  55.       1) Create a directory to hold all LMATCH files
  56.  
  57.       2) Unzip LMATCHxx.ZIP into the the above directory
  58.  
  59.       3) Create a configuration file, with a name of your choice, or
  60.          modify the supplied LMATCH.CFG file. A description follows:
  61.  
  62.             **                       Location of system file (See Below)
  63.             SUNRISE-80 BBS           Your BBS Name
  64.             Al                       Sysop's First name
  65.  
  66.             Lawrence                 Sysop's Last Name
  67.  
  68. |-----------------------------------------------------------------------------|
  69. | READ!     1                        CommPort  \ These 2 lines are required   |
  70. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  71. |-----------------------------------------------------------------------------|
  72.  
  73.             00000000                 Registration Number
  74.  
  75.     !   #   2                        Maximum # of Games per day
  76.                                      (Sysop gets 99, Registered version ONLY)
  77.  
  78.         #   0                        Max # of days a caller can make up, during
  79.                                      calls in one day. 0=Disable Make-up Option
  80.                                      Maximum value = 27, Minimum value = 1
  81.  
  82.         #   NONE                     Drive:\Path\Filename to contain the
  83.                                      Top Score Bulletin or enter NONE
  84.                                      for NO Bulletin creation.
  85.  
  86.         #   NONE                     Drive:\Path\Filename to contain the
  87.                                      Top Score Bulletin (Color) or enter NONE
  88.                                      for NO Bulletin creation.
  89.  
  90.         #   NONE                     Drive:\Path\Filename to contain the
  91.                                      Hall of Fame Bulletin or enter NONE
  92.                                      for NO Bulletin creation.
  93.  
  94.         #   NONE                     Drive:\Path\Filename to contain the
  95.                                      Hall of Fame Bulletin (Color) or enter NONE
  96.                                      for NO Bulletin creation.
  97.  
  98.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  99.                                      2 = Display ADOPT-A-DOOR message
  100.  
  101.         #   2                        Keyboard timeout value in Minutes
  102.  
  103.     !   #   0                        Time allowed in Door
  104.                                      (Sysop = Time Remaining - REG. VERSION)
  105.  
  106.             c:\bbs\door\lmatch.cat   Drive:\Path\Filename of the Category file
  107.  
  108.         #   N                        Y = Play a Solitaire Game
  109.                                      N = Computer plays
  110.  
  111.         #   1                        Scoring: Points earned per match
  112.  
  113.         #   N                        Automatic game reset at end of month:
  114.                                        Y = Yes enable autoreset
  115.                                        N = Keep accumulating scores
  116.  
  117.         #   Y                        Y = Allow Sysop to have 999 games
  118.                                      N = Do Not Allow Sysop 999 games
  119.  
  120.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  121.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  122.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  123.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  124.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  125.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  126.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  127.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  128.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  129.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  130.     @   #   XXXX/YYYY                 Blackout Range  From/To
  131.     @   #   XXXX/YYYY                 Blackout Range  From/To
  132.     @   #   XXXX/YYYY                 Blackout Range  From/To
  133.     @   #   XXXX/YYYY                 Blackout Range  From/To
  134.     @   #   XXXX/YYYY                 Blackout Range  From/To
  135.  
  136.  
  137.  
  138.               ** = Replace with ONE of the following:
  139.  
  140. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  141. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  142. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  143.                                    (Note:DOOR.SYS must be in SAME directory)
  144. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  145. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  146. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  147. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  148. C:\BBS\CHAIN.TXT                <- For WWIV systems
  149. C:\BBS\GTUSER.BBS               <- For GT Power
  150.                                    * if using this option you must put the
  151.                                      ComPort # on line 5 and the Node # on
  152.                                      line 6 of the configuration file
  153.  
  154.  
  155.  
  156.            # = Requires registration to change to a different value.
  157.            ! = See "Plays Per Day" Below
  158.            @ = See "Blackout Periods" Below
  159.  
  160.                NOTE: There are NO Blank Lines in the Config File!!
  161.  
  162.  
  163.  
  164.  
  165.       4) Create a batch file or modify the LMATCH file supplied. A
  166.          description of this file follows:
  167.  
  168.             ECHO off
  169.             cd\BBS\DOORS\LMATCH       Location of LMATCH files
  170.             LMATCH LMATCH.CFG         EXE filename and CFG filename (Name
  171.                                       used in creating file in #3 above)
  172.             CD\BBS
  173.             BOARD
  174.  
  175.  
  176.        5) When running in more than one node, be sure to supply a
  177.           different configuration name for each node (your choice of name).
  178.  
  179.        6) If running with Fossil-based multi-port boards add
  180.            /FD to the line containing the CFG name as follows:
  181.  
  182.                        LMATCH LMATCH.CFG /FD
  183.  
  184.  
  185.  
  186.                          CATEGORY FILES
  187.                          --------------
  188.  
  189. In the unregistered version of Letter Match, you MUST use the category I have
  190. supplied, STATES and CAPITALS, in the file called LMATCH.CAT.
  191.  
  192. After registration you are free to use the extra category file I have
  193. included in the LMATCHxx.ZIP (XTRA1.CAT-XTRA5-CAT) or you may modify the extra
  194. file or you may create your own. If you will be creating your own or modifying
  195. the extra ones, you must ensure that you follow this format:
  196.  
  197. Line 1: CAT:xxxxxxxxx
  198.  
  199.       CAT:    must be left as you see it
  200.       xxxxxxx is the category title that will appear in the box used to display
  201.               the individual category entries. The maximum length = 40 char.
  202.  
  203. Line 2: Category Entry
  204.  
  205.         All category entries can have a maximum length of 40 characters.
  206.         You may have up to 500 entries in each category file.
  207.  
  208. The types of categories are only limited by your imagination. I would suggest
  209. that you place a substantial number of entries in each category file and at a
  210. minimum be sure you include all the possible answers for that category (or as
  211. many as you can find). I can assure you your users will come up with ones you
  212. have missed <GRIN>. With that in mind, I will apologize now for any mistakes
  213. or ommissions in the extra category files I have supplied <g>..
  214.  
  215.  
  216.                MAKE-UP DAYS (Registered version only)
  217.                --------------------------------------
  218.  
  219. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  220. during the current month and prior to the current call. You control whether
  221. to allow this option, as well as the number of days the caller can make up, on
  222. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  223. configuration file, turns the option OFF, any other value (up to a max of 27)
  224. turns the option ON and dictates the number of days the caller can make up.
  225.  
  226.  
  227. NOTE:      The number of games per day is calculated as follows...
  228.  
  229.            Games Allowed per day x Number of makeup days.
  230.  
  231. Example:   Games Allowed per day = 2
  232.            Max # of makeup days  = 4
  233.  
  234. If a caller logs in on 5/8/92 and this is their first call of the month, they
  235. would have a potential of 16 games to makeup and bring them current
  236. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  237. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  238. (games allowed * max # of makeup days).
  239.  
  240.  
  241.  
  242.              HALL OF FAME BULLETINS (Registered version only)
  243.              ------------------------------------------------
  244.  
  245. The program will automatically reset the game when the first caller of the
  246. month plays the game. The score file will be cleared and a set of Hall of Fame
  247. bulletin files will be created. The files will be called SUNHOF.ASC and
  248. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  249. directory as the LAMTCH.EXE file. You are responsible for COPYING the files to
  250. your bulletin area and renaming to a filename of your choice.
  251.  
  252. WARNING: The HOF files are cumulative files. That means they are read in each
  253.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  254.          the record of prior months winners!!!!
  255.  
  256.  
  257.  
  258.                           BLACKOUT PERIODS
  259.                           ________________
  260.  
  261.       Use the Blackout ranges option to define up to 5 time periods during
  262.       which you DO NOT want the Door to be played. If a caller tries to access
  263.       the Door during the Blackout period, they will be shown a message that
  264.       contains ALL the Blackout periods you have defined, and to try the Door
  265.       at a later time.
  266.  
  267.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  268.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  269.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  270.  
  271.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  272.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  273.                    a Blackout range.
  274.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  275.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  276.  
  277.  
  278.  
  279.                           PLAYS Per DAY/DOOR Time
  280.                           _______________________
  281.  
  282.       Plays Per Day and Door Time can be controlled several ways:
  283.  
  284.       (1) You can use the Games Per Day, singular option, in the config
  285.           file above. This option, will affect ALL callers whose Security
  286.           Level is NOT defined in any of the 10 optional Security Level/
  287.           Plays Per Day entries in the config file.
  288.  
  289.       (2) You can use the Door Time, singular option, in the config file
  290.           above. This option, will affect ALL callers whose Security
  291.           Level is NOT defined in any of the 10 optional Security Level/
  292.           Plays Per Day/Door Time entries in the config file.
  293.  
  294.       (3) You can restrict the number of games a specific Security Level
  295.           will be allowed to play per day or REWARD specific Levels with
  296.           more Plays Per Day.
  297.  
  298.           Likewise, you can restrict the Play time for a specific Security
  299.           Level or REWARD specific Levels with more Door Time.
  300.  
  301.           These options are handled by the use of the 10 config
  302.           entries (000=00/00).
  303.  
  304.           The format of each entry is as follows:
  305.  
  306.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  307.                      where =  is a constant and MUST be included
  308.                      where YY is the # of games per day (must be 2 digits)
  309.                      where / is a constant and MUST be included
  310.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  311.  
  312.           If the callers Security Level is NOT defined, his/her Plays Per
  313.           Day and Door Time will be controlled by the values in items
  314.           (1) and (2), above, respectively..
  315.  
  316.           You may define up to 10 Security Levels. All unused entries must
  317.           be defined as   000=00/00
  318.         --------------------------------------------------------------------
  319.           Example: Suppose you had 3 Security Levels defined on your BBS as
  320.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  321.           wanted to set Plays Per Day as :     Subscriber=5
  322.                                            Visiting Sysop=2
  323.                                                   CoSysop=3
  324.                                                    Friend=10
  325.  
  326.           and Door Time as follows:     Subscriber=30 minutes
  327.                                     Visiting Sysop=20 minutes
  328.                                            CoSysop=10 minutes
  329.                                             Friend=remaining call time
  330.  
  331.  
  332.           You would set the Individual "Games per Day" config entry to 1 and
  333.           the individual "Door Time" to 5 minutes (these would be the
  334.           default number of games and default Time for all Security Levels
  335.           other than 20,30 or 40... make them any number you want). Next you
  336.           would replace 4 of the Security Level entries as :  020=05/30
  337.                                                               030=02/20
  338.                                                               040=03/10
  339.                                                               090=10/0
  340.  
  341.  
  342.                         NON-STANDARD COM SUPPORT
  343.                         ________________________
  344.  
  345.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  346.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  347.       number after the configuration filename. Let's assume your Door is
  348.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  349.       passed to your Door would be:
  350.  
  351.                             FOOBAR FOOBAR.CFG /5
  352.  
  353.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  354.       normally used with COM1. No /x parameter is needed for the standard
  355.       IRQ's.
  356.  
  357.       As an alternative, you may use an environmental variable on the command
  358.       line. To use the variable (following the example above), place a
  359.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  360.       different IRQ number for each node). The command line would now look
  361.       like this:
  362.  
  363.                           FOOBAR FOOBAR.CFG /%IRQ%
  364.  
  365.       This, in combination with the use of the environmental variables
  366.       described in the MULTI-NODE SETUP section will allow you to use one
  367.       batch file and one config file to run this door on all nodes.
  368.  
  369.  
  370.  
  371.  
  372.                            MULTI-NODE SETUP
  373.                            ________________
  374.  
  375.       All Sunrise Doors are Multi-Node capable. Each node must have the
  376.       ability to access a configuration file which will have its own system
  377.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  378.       line. There are 2 ways to accomplish this:
  379.  
  380.       (1) Create a separate configuration file for each node. The only
  381.           difference between each file would be the location of the system
  382.           file for that particular node. For example, on my system there are 2
  383.           nodes and the first line of the config files would look like this:
  384.  
  385.                         NODE1:  H:\PCB1\DOOR.SYS
  386.                         NODE2:  H:\PCB2\DOOR.SYS
  387.  
  388.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  389.  
  390.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  391.           the following PCBoard environmental variables:
  392.  
  393.                  PCBDIR    (Directory containing the System file)
  394.                  PCBDRIVE  (Drive containing the System file)
  395.  
  396.           Thus, the first line of the SINGLE configuration file, for this Door
  397.           would look like this:
  398.  
  399.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  400.  
  401.       NOTE: This option, as described, assumes that you are running PCBoard
  402.             14.5a software. The environmental variables are automatically
  403.             created by the software for each node.
  404.  
  405.             HOWEVER, if you are running other BBS software you should be able
  406.             to set the variables EXACTLY as described below, for EACH node
  407.             (more than likely in each batch file you use to bring up EACH node):
  408.  
  409.                             PCBDRIVE=C:
  410.                             ^^^^^^^^^
  411.                             PCBDIR=\NODE2
  412.                             ^^^^^^^^
  413.  
  414.             Info with a carat (^) under it, MUST be typed as is. The rest
  415.             depends on your naming conventions.
  416.  
  417.             This, in combination with the use of the optional environmental
  418.             variable described in the NON-STANDARD COM SUPPORT section, will
  419.             allow you to use one batch file and one config file to run this
  420.             door on all nodes.
  421.  
  422.  
  423.  
  424.                                ADOPT-A-DOOR
  425.                                ____________
  426.  
  427.     Having been a Sysop for a number of years, I have had my share of problems
  428.     and frustrations getting financial support for my board's upkeep. A fellow
  429.     Sysop left a message on my board, not long ago, about a concept that was
  430.     being used by several boards around the country.
  431.  
  432.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  433.     would be the same as sending in a donation, only this way it is earmarked
  434.     for registering a particular door. In a way, the user feels he/she is
  435.     "getting something in return". As a Door author I have decided to build
  436.     this concept into each of my Door programs. The concept replaces the
  437.     usual message "tell the Sysop to register this Door" we find in most
  438.     doors.
  439.  
  440.     If the Door is unregisterd then a message appears on the opening screen
  441.     to that effect. After finishing or suspending a game, a message screen
  442.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  443.     caller to contact the Sysop to find out if there is any further details
  444.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  445.     time, etc to callers that ADOPT-A-DOOR.
  446.  
  447.     If the Door has been registered, either by the Sysop or other callers,
  448.     the names of those contributors will be displayed in the closing screen.
  449.  
  450.     NOTE: If you want to display the names of the callers that contributed
  451.           to registering the Door, you must create an ASCII file called
  452.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  453.           the name(s) of the contributors (one on each line, maximum of 5
  454.           entries, each a maximum of 30 characters long). This file must be
  455.           saved, in ASCII format, and placed in the Door directory.
  456.  
  457.  
  458.  
  459.                               LEGALITIES
  460.                               __________
  461.  
  462.  
  463.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  464.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  465.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  466.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  467.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  468.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  469.       OR BREACH OF ANY WARRANTY.
  470.  
  471.  
  472.  
  473.  
  474.  
  475.                              DISTRIBUTION
  476.                              ____________
  477.  
  478.    You may make this file available for downloading from your BBS or you may
  479.    upload it to any BBS of your choice, provided that you do not make any
  480.    changes to the contents of the archive (ZIP file). The archive and its
  481.    individual contents may not be used by any service that charges any money
  482.    whatsoever, without the written permission of the author.
  483.  
  484.  
  485.  
  486.  
  487.  
  488.                              REGISTRATION
  489.                              ____________
  490.  
  491.    Registration and the subsequent insertion of the registration number into
  492.    your configuation file, allows for the display of your BBS name on the
  493.    opening and closing screen as well as the reduction of a delay built into
  494.    the opening screen display along with the ability to change certain
  495.    values in the configuration file.
  496.  
  497.    To register your copy of LMATCH please fill out the registration form
  498.    (REGISTER.FRM) and mail it along with the registration fee to
  499.    the name and address on the form.
  500.  
  501.    Be sure to use the proper upper/lower case when filling in your name and
  502.    BBS name, as they MUST match the way you entered them in the configuration
  503.    file.             ^^^^
  504.  
  505.    Based upon information supplied on the registration form, I will pre-
  506.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  507.    up your registration number.
  508.  
  509.  
  510.  
  511.                                  MISC
  512.                                  ____
  513.  
  514.    The latest version of Letter Match and other fine SUNRISE DOOR programs
  515.    are always available for download from SUNRISE-80 BBS.
  516.  
  517.    Remember, should you have any problems, questions or suggestions, be sure
  518.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  519.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  520.